Category list helpers #25777

rezkiy37 · 2023-08-23T15:48:06Z

Details

This is the second PR of four for the issue. Goals for this PR:

Create getOptionTree function, to format the parent sections we'll need to utilize a helper method to transform the "Parent: Child" category format into a format that is easier to interpret.
Extend getOptions function, to split categories by sections.
Extend getNewChatOptions function, to filter the options using the function.
Implement tests for as many cases as possible.

Fixed Issues

$ #24463
PROPOSAL: N/A

Tests

Since, the PR does not reflect on any existing flow, it does not require any actions with the app to verify. Basically, everything should work as it is in the production. Also, there are many tests for these changes.

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

N/A

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

…ture/24463-category-helpers

src/libs/OptionsListUtils.js

melvin-bot · 2023-08-25T14:02:25Z

@sobitneupane Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

…ture/24463-category-helpers

rezkiy37 · 2023-08-29T15:46:57Z

A few important commits have been pushed.

yuwenmemon · 2023-08-23T19:54:20Z

src/CONST.js

@@ -2591,6 +2591,9 @@ const CONST = {
            NAVIGATE: 'NAVIGATE',
        },
    },
+    INDENTS: '    ',


I wonder if we can use  's here or would those automatically be escaped?

I'm not sure that we can use it out of JSX.

There is a way to use String.fromCharCode(160), it looks like:
INDENTS: String.fromCharCode(160) + String.fromCharCode(160) + String.fromCharCode(160) + String.fromCharCode(160),

I like spaces better than that haha

src/libs/OptionsListUtils.js

…ture/24463-category-helpers

situchan

@rezkiy37 please add video at least on web

src/pages/tasks/TaskAssigneeSelectorModal.js

situchan · 2023-08-30T21:01:41Z

Based on goals for this PR, nothing to test here in the app. Automated test is fine I think.

src/libs/OptionsListUtils.js

rezkiy37 · 2023-08-31T07:42:31Z

@rezkiy37 please add video at least on web

I'm not lazy, I just do not know what to record for this PR. This code will work only in a scope of next PR, where I am adding UI/UX.

situchan · 2023-08-31T07:43:37Z

@rezkiy37 please add video at least on web

I'm not lazy, I just do not know what to record for this PR. This code will work only in a scope of next PR, where I am adding UI/UX.

sure thing. so I updated comment - #25777 (comment)

situchan · 2023-08-31T07:54:37Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

situchan

LGTM

yuwenmemon

Damn, nice work! Just a NAB comment from me 😍

src/CONST.ts

puneetlath

Just some small comments.

Tests are great!

puneetlath · 2023-08-31T17:50:06Z

src/libs/OptionsListUtils.js

+ * @param {Boolean} [isOneLine] - a flag to determine if text should be one line
+ * @returns {Array<Object>}
+ */
+function getOptionTree(options, isOneLine = false) {


Will this function be used for anything other than categories? If not, perhaps we could make the function name more specific. Like getCategoryOptionTree or something.

Agree. Done!

puneetlath · 2023-08-31T17:51:07Z

src/libs/OptionsListUtils.js

@@ -587,6 +587,138 @@ function isCurrentUser(userDetails) {
    return _.some(_.keys(loginList), (login) => login.toLowerCase() === userDetailsLogin.toLowerCase());
 }

+/**
+ * Build the options for the tree hierarchy via indents


Suggested change

* Build the options for the tree hierarchy via indents

* Build the options for the category tree hierarchy via indents

NAB: just a little bit more specific since I think this is only used for categories.

Agree. Done!

puneetlath · 2023-08-31T17:52:48Z

src/libs/OptionsListUtils.js

+        const searchCategories = _.filter(categories, (category) => category.name.toLowerCase().includes(searchInputValue.toLowerCase()));
+
+        categorySections.push({
+            title: '', // Search


What does this comment mean?

These comments mean which section we push. There are cases when no visible title. Anyway, I've tried to improve the comments. Please check.

OSBotify · 2023-08-31T19:38:54Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2023-08-31T23:16:43Z

🚀 Deployed to staging by https://github.com/yuwenmemon in version: 1.3.61-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2023-09-01T23:09:17Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.61-3 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

cubuspl42 · 2023-10-31T15:12:53Z

src/libs/OptionsListUtils.js

+ * @param {Boolean} [isOneLine] - a flag to determine if text should be one line
+ * @returns {Array<Object>}
+ */
+function getCategoryOptionTree(options, isOneLine = false) {


Coming from #29281

This operator didn't order the sub-categories correctly

tienifr · 2024-06-01T16:46:01Z

src/libs/OptionsListUtils.js

+                keyForList: optionName,
+                searchText: array.slice(0, index + 1).join(CONST.PARENT_CHILD_SEPARATOR),
+                tooltipText: optionName,
+                isDisabled: isChild ? !option.enabled : true,


@rezkiy37 I wonder why do we need to check isChild here? Can you help explain when you have a chance? Thanks

Yeah, as you can see above there is a definition for isChild - = array.length - 1 === index. So for example there is an option parent:child. It automatically sets isDisabled as true for parent. However, it checks option.enabled for child. Because only child is an option that can be disabled or enabled. parent is an option that can be disabled with this example. To enable parent the app should have a specific parent option.

TY for your explanation. That makes sense!

(BugZero Checklist) Coming from #42936, We ended up modifying the isDisabled condion to have hover effect over selected parent category in the list

rezkiy37 added 8 commits August 22, 2023 16:15

implement get option tree helper

a35200e

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fea…

4540bf5

…ture/24463-category-helpers

extend getOptionTree

22c7397

use object instead of Map

1b9429e

extend get options for categories

cb03605

implement category sections

2b22f9c

remove todo

87f69e8

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fea…

36fff23

…ture/24463-category-helpers

BeeMargarida reviewed Aug 24, 2023

View reviewed changes

src/libs/OptionsListUtils.js Outdated Show resolved Hide resolved

rezkiy37 marked this pull request as ready for review August 25, 2023 14:02

rezkiy37 requested a review from a team as a code owner August 25, 2023 14:02

melvin-bot bot requested review from sobitneupane and removed request for a team August 25, 2023 14:02

rezkiy37 added 7 commits August 28, 2023 11:38

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fea…

895e9d5

…ture/24463-category-helpers

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fea…

1bc269e

…ture/24463-category-helpers

fix helpers

e283151

recent one line

8307678

add translations

846e9b3

enable all tests

f7ff0c6

integrate index offset

91d3dde

yuwenmemon reviewed Aug 29, 2023

View reviewed changes

rezkiy37 added 2 commits August 30, 2023 11:32

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fea…

f7d6e5f

…ture/24463-category-helpers

create section list getter

657850f

puneetlath requested a review from situchan August 30, 2023 14:49

situchan reviewed Aug 30, 2023

View reviewed changes

src/pages/tasks/TaskAssigneeSelectorModal.js Outdated Show resolved Hide resolved

situchan reviewed Aug 30, 2023

View reviewed changes

src/libs/OptionsListUtils.js Outdated Show resolved Hide resolved

rezkiy37 added 2 commits August 31, 2023 09:46

rename variable

d0376ec

clarify types of recently used categories

cc85e52

rezkiy37 requested a review from situchan August 31, 2023 07:53

situchan approved these changes Aug 31, 2023

View reviewed changes

melvin-bot bot requested a review from yuwenmemon August 31, 2023 07:55

amyevans mentioned this pull request Aug 31, 2023

[HOLD for payment 2023-09-21] [Wave 6: Categories] CRITICAL - Create Category MenuItem and CategoryPicker component #24463

Closed

3 tasks

yuwenmemon previously approved these changes Aug 31, 2023

View reviewed changes

src/CONST.ts Show resolved Hide resolved

puneetlath requested changes Aug 31, 2023

View reviewed changes

minor fixes

d9d3e6c

rezkiy37 dismissed yuwenmemon’s stale review via d9d3e6c August 31, 2023 19:23

rezkiy37 requested review from puneetlath and yuwenmemon August 31, 2023 19:25

puneetlath approved these changes Aug 31, 2023

View reviewed changes

yuwenmemon approved these changes Aug 31, 2023

View reviewed changes

yuwenmemon merged commit b226893 into Expensify:main Aug 31, 2023

OSBotify mentioned this pull request Aug 31, 2023

Deploy Checklist: New Expensify 2023-08-31 #26444

Closed

36 tasks

rezkiy37 mentioned this pull request Sep 4, 2023

Categories UI/UX #26501

Merged

59 tasks

cubuspl42 reviewed Oct 31, 2023

View reviewed changes

cubuspl42 mentioned this pull request Oct 31, 2023

[HOLD for payment 2023-11-02] Category IOU - Incorrect ordering of subcategories in the category menu #28964

Closed

6 tasks

nkdengineer mentioned this pull request May 15, 2024

[HOLD for payment 2024-06-05] [$125] Category - Clicking on a very long parent child category name scrolls the page #41850

Closed

6 tasks

tienifr reviewed Jun 1, 2024

View reviewed changes

tienifr mentioned this pull request Jun 14, 2024

[HOLD for payment 2024-07-17] [$250] Category - No hover effect when hovering over selected parent category in the list #42936

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Category list helpers #25777

Category list helpers #25777

rezkiy37 commented Aug 23, 2023 •

edited

Loading

melvin-bot bot commented Aug 25, 2023

rezkiy37 commented Aug 29, 2023

yuwenmemon Aug 23, 2023

rezkiy37 Aug 29, 2023

rezkiy37 Aug 29, 2023

yuwenmemon Aug 31, 2023

situchan left a comment

situchan commented Aug 30, 2023

rezkiy37 commented Aug 31, 2023

situchan commented Aug 31, 2023

situchan commented Aug 31, 2023

situchan left a comment •

edited

Loading

yuwenmemon left a comment

puneetlath left a comment

puneetlath Aug 31, 2023

rezkiy37 Aug 31, 2023

puneetlath Aug 31, 2023

rezkiy37 Aug 31, 2023

puneetlath Aug 31, 2023

rezkiy37 Aug 31, 2023

OSBotify commented Aug 31, 2023

OSBotify commented Aug 31, 2023

OSBotify commented Sep 1, 2023

cubuspl42 Oct 31, 2023

tienifr Jun 1, 2024

rezkiy37 Jun 3, 2024

tienifr Jun 3, 2024

ishpaul777 Jul 22, 2024

	* Build the options for the tree hierarchy via indents
	* Build the options for the category tree hierarchy via indents

Category list helpers #25777

Category list helpers #25777

Conversation

rezkiy37 commented Aug 23, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 25, 2023

rezkiy37 commented Aug 29, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

situchan left a comment

Choose a reason for hiding this comment

situchan commented Aug 30, 2023

rezkiy37 commented Aug 31, 2023

situchan commented Aug 31, 2023

situchan commented Aug 31, 2023

Reviewer Checklist

Screenshots/Videos

situchan left a comment • edited Loading

Choose a reason for hiding this comment

yuwenmemon left a comment

Choose a reason for hiding this comment

puneetlath left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OSBotify commented Aug 31, 2023

OSBotify commented Aug 31, 2023

OSBotify commented Sep 1, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rezkiy37 commented Aug 23, 2023 •

edited

Loading

situchan left a comment •

edited

Loading